Resource URL: /platform/<<version=1>>/auth/providers/krb5/<ID>

    Overview: This resource applies the standard collection pattern to
              individual Kerberos providers.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the KRB5 provider.

       URL: GET /platform/<<version=1>>/auth/providers/krb5/<ID>

Query arguments:
scope=<enum> Where <enum> is one of user, default, effective.  If specified as
             "effective" or not specified, all fields are returned.  If
             specified as "user", only fields with non-default values are
             shown.  If specified as "default", the original values are
             returned.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "krb5": {
      "items": {
        "type": "object", 
        "description": "Specifies properties for the Kerberos authentication provider.", 
        "properties": {
          "status": {
            "type": "string", 
            "description": "Specifies the status of the provider."
          }, 
          "realm": {
            "type": "string", 
            "description": "Specifies the name of realm."
          }, 
          "name": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the Kerberos provider name."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "recommended_spns": {
            "type": [
              {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies the recommended SPNs."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "keytab_entries": {
            "type": [
              {
                "items": {
                  "type": "object", 
                  "description": "Krb5 SPN Key info", 
                  "properties": {
                    "encryption": {
                      "items": {
                        "type": "string"
                      }, 
                      "type": "array", 
                      "description": "Specifies the encryption types."
                    }, 
                    "kvno": {
                      "type": "integer", 
                      "description": "Specifies the version number of the SPN key."
                    }, 
                    "spn": {
                      "type": "string", 
                      "description": "Specifies the Service Principal Name (SPN)."
                    }, 
                    "timestamp": {
                      "type": "integer", 
                      "description": "Specifies the time the SPN key was created."
                    }
                  }
                }, 
                "type": "array", 
                "description": "Specifies the key information for the Kerberos SPNs."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "system": {
            "type": [
              {
                "type": "boolean", 
                "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed"
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "user": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the name of the user that performs kadmin tasks."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "keytab_file": {
            "type": "string", 
            "description": "Specifies the path to a keytab file to import."
          }, 
          "id": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the Kerberos provider ID."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "manual_keying": {
            "type": "boolean", 
            "description": "If true, keys are managed manually. If false, keys are managed through kadmin."
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify the KRB5 provider.

       URL: PUT /platform/<<version=1>>/auth/providers/krb5/<ID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies properties for the Kerberos authentication provider.", 
  "properties": {
    "status": {
      "type": "string", 
      "description": "Specifies the status of the provider."
    }, 
    "realm": {
      "type": "string", 
      "description": "Specifies the name of realm."
    }, 
    "name": {
      "type": "string", 
      "description": "Specifies the Kerberos provider name."
    }, 
    "keytab_entries": {
      "items": {
        "type": "object", 
        "description": "Krb5 SPN Key info", 
        "properties": {
          "encryption": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the encryption types."
          }, 
          "kvno": {
            "type": "integer", 
            "description": "Specifies the version number of the SPN key."
          }, 
          "spn": {
            "type": "string", 
            "description": "Specifies the Service Principal Name (SPN)."
          }, 
          "timestamp": {
            "type": "integer", 
            "description": "Specifies the time the SPN key was created."
          }
        }
      }, 
      "type": "array", 
      "description": "Specifies the key information for the Kerberos SPNs."
    }, 
    "user": {
      "type": "string", 
      "description": "Specifies the name of the user that performs kadmin tasks."
    }, 
    "password": {
      "type": "string", 
      "description": "Specifies the Kerberos provider password."
    }, 
    "keytab_file": {
      "type": "string", 
      "description": "Specifies the path to a keytab file to import."
    }, 
    "manual_keying": {
      "type": "boolean", 
      "description": "If true, keys are managed manually. If false, keys are managed through kadmin."
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete the KRB5 provider.

          URL: DELETE /platform/<<version=1>>/auth/providers/krb5/<ID>

There are no query arguments for this method.

There is no response body for this method.
